<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Voodoo Shader Framework: VoodooShader::Formatter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespace_voodoo_shader.html">VoodooShader</a>::<a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a>
  </div>
</div>
<div class="contents">
<h1>VoodooShader::Formatter Class Reference</h1><!-- doxytag: class="VoodooShader::Formatter" -->
<p>Logging Format class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_logger_8hpp_source.html">Logger.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for VoodooShader::Formatter:</div>
<div class="dynsection">
<div class="center"><img src="class_voodoo_shader_1_1_formatter__coll__graph.png" border="0" usemap="#_voodoo_shader_1_1_formatter_coll__map" alt="Collaboration graph"/></div>
<map name="_voodoo_shader_1_1_formatter_coll__map" id="_voodoo_shader_1_1_formatter_coll__map">
<area shape="rect" id="node2" href="class_voodoo_shader_1_1_logger.html" title="Logfile management class, capable of opening, closing, writing to and dumping log..." alt="" coords="13,101,168,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_voodoo_shader_1_1_formatter-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#ae71867d0eb64b74d04030213928cadb5">Done</a> (bool timestamp=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalizes a formatted string and prints it to the log.  <a href="#ae71867d0eb64b74d04030213928cadb5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#a36300b3526191c50d36b651d0e65d661">Formatter</a> (<a class="el" href="class_voodoo_shader_1_1_logger.html">Logger</a> *parent)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a log format object.  <a href="#a36300b3526191c50d36b651d0e65d661"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#ae0388924ee3bbc8c05d725905f4cce75">Record</a> (std::string fmtString)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begins logging a message (passes an initial formatting string).  <a href="#ae0388924ee3bbc8c05d725905f4cce75"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#a09a307c8137a95f55ed38dcd63727b08">With</a> (const T &amp;varString)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Passes a single argument to this format object.  <a href="#a09a307c8137a95f55ed38dcd63727b08"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#acd189536db2a1077fe75431b9acf868f">With</a> (T &amp;varString)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Passes a single argument to this format object.  <a href="#acd189536db2a1077fe75431b9acf868f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boost::format&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#ae3949edb9f01381b532e17303d91d946">mFmtObj</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_voodoo_shader_1_1_logger.html">Logger</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_formatter.html#aec907d7883bb74ef0641f1b7ca2066c8">mParent</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Logging Format class. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Formats strings using Boost::Format. See docs for full available syntax. </dd>
<dd>
Only used internally in <a class="el" href="class_voodoo_shader_1_1_logger.html" title="Logfile management class, capable of opening, closing, writing to and dumping log...">Logger</a>. </dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a36300b3526191c50d36b651d0e65d661"></a><!-- doxytag: member="VoodooShader::Formatter::Formatter" ref="a36300b3526191c50d36b651d0e65d661" args="(Logger *parent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">VOODOO_API VoodooShader::Formatter::Formatter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_voodoo_shader_1_1_logger.html">Logger</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a log format object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The <a class="el" href="class_voodoo_shader_1_1_logger.html" title="Logfile management class, capable of opening, closing, writing to and dumping log...">Logger</a> to be attached as the parent. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae71867d0eb64b74d04030213928cadb5"></a><!-- doxytag: member="VoodooShader::Formatter::Done" ref="ae71867d0eb64b74d04030213928cadb5" args="(bool timestamp=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">VOODOO_API void VoodooShader::Formatter::Done </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>timestamp</em> = <code>true</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Finalizes a formatted string and prints it to the log. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timestamp</em>&nbsp;</td><td>Prepend a timestamp to the logged message. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae0388924ee3bbc8c05d725905f4cce75"></a><!-- doxytag: member="VoodooShader::Formatter::Record" ref="ae0388924ee3bbc8c05d725905f4cce75" args="(std::string fmtString)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a>&amp; VoodooShader::Formatter::Record </td>
          <td>(</td>
          <td class="paramtype">std::string&nbsp;</td>
          <td class="paramname"> <em>fmtString</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Begins logging a message (passes an initial formatting string). </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fmtString</em>&nbsp;</td><td>A format string, formed according to the boost::format docs. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to this <a class="el" href="class_voodoo_shader_1_1_formatter.html" title="Logging Format class.">Formatter</a>. </dd></dl>

</div>
</div>
<a class="anchor" id="a09a307c8137a95f55ed38dcd63727b08"></a><!-- doxytag: member="VoodooShader::Formatter::With" ref="a09a307c8137a95f55ed38dcd63727b08" args="(const T &amp;varString)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a>&amp; VoodooShader::Formatter::With </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&nbsp;</td>
          <td class="paramname"> <em>varString</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Passes a single argument to this format object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>varString</em>&nbsp;</td><td>A value or object to be formatted and placed into the format stream. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to this <a class="el" href="class_voodoo_shader_1_1_formatter.html" title="Logging Format class.">Formatter</a>. </dd></dl>

</div>
</div>
<a class="anchor" id="acd189536db2a1077fe75431b9acf868f"></a><!-- doxytag: member="VoodooShader::Formatter::With" ref="acd189536db2a1077fe75431b9acf868f" args="(T &amp;varString)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_voodoo_shader_1_1_formatter.html">Formatter</a>&amp; VoodooShader::Formatter::With </td>
          <td>(</td>
          <td class="paramtype">T &amp;&nbsp;</td>
          <td class="paramname"> <em>varString</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Passes a single argument to this format object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>varString</em>&nbsp;</td><td>A value or object to be formatted and placed into the format stream. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to this <a class="el" href="class_voodoo_shader_1_1_formatter.html" title="Logging Format class.">Formatter</a>. </dd></dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae3949edb9f01381b532e17303d91d946"></a><!-- doxytag: member="VoodooShader::Formatter::mFmtObj" ref="ae3949edb9f01381b532e17303d91d946" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boost::format <a class="el" href="class_voodoo_shader_1_1_formatter.html#ae3949edb9f01381b532e17303d91d946">VoodooShader::Formatter::mFmtObj</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aec907d7883bb74ef0641f1b7ca2066c8"></a><!-- doxytag: member="VoodooShader::Formatter::mParent" ref="aec907d7883bb74ef0641f1b7ca2066c8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_voodoo_shader_1_1_logger.html">Logger</a>* <a class="el" href="class_voodoo_shader_1_1_formatter.html#aec907d7883bb74ef0641f1b7ca2066c8">VoodooShader::Formatter::mParent</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>K:/VoodooShader/Framework/<a class="el" href="_logger_8hpp_source.html">Logger.hpp</a></li>
<li>K:/VoodooShader/Framework/<a class="el" href="_logger_8cpp.html">Logger.cpp</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Oct 14 23:19:05 2010 for Voodoo Shader Framework by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
